home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chegvd.z / chegvd
Encoding:
Text File  |  2002-10-03  |  8.4 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHEGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a complex generalized Hermitian-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CHEGVD( ITYPE, JOBZ, UPLO, N, A, LDA, B, LDB, W, WORK, LWORK,
  15.                         RWORK, LRWORK, IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, ITYPE, LDA, LDB, LIWORK, LRWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          REAL           RWORK( * ), W( * )
  24.  
  25.          COMPLEX        A( LDA, * ), B( LDB, * ), WORK( * )
  26.  
  27. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  28.      These routines are part of the SCSL Scientific Library and can be loaded
  29.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  30.      directs the linker to use the multi-processor version of the library.
  31.  
  32.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  33.      4 bytes (32 bits). Another version of SCSL is available in which integers
  34.      are 8 bytes (64 bits).  This version allows the user access to larger
  35.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  36.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  37.      only one of the two versions; 4-byte integer and 8-byte integer library
  38.      calls cannot be mixed.
  39.  
  40. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  41.      CHEGVD computes all the eigenvalues, and optionally, the eigenvectors of
  42.      a complex generalized Hermitian-definite eigenproblem, of the form
  43.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  44.      assumed to be Hermitian and B is also positive definite.  If eigenvectors
  45.      are desired, it uses a divide and conquer algorithm.
  46.  
  47.      The divide and conquer algorithm makes very mild assumptions about
  48.      floating point arithmetic. It will work on machines with a guard digit in
  49.      add/subtract, or on those binary machines without guard digits which
  50.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  51.      conceivably fail on hexadecimal or decimal machines without guard digits,
  52.      but we know of none.
  53.  
  54.  
  55. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  56.      ITYPE   (input) INTEGER
  57.              Specifies the problem type to be solved:
  58.              = 1:  A*x = (lambda)*B*x
  59.              = 2:  A*B*x = (lambda)*x
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 3:  B*A*x = (lambda)*x
  75.  
  76.      JOBZ    (input) CHARACTER*1
  77.              = 'N':  Compute eigenvalues only;
  78.              = 'V':  Compute eigenvalues and eigenvectors.
  79.  
  80.      UPLO    (input) CHARACTER*1
  81.              = 'U':  Upper triangles of A and B are stored;
  82.              = 'L':  Lower triangles of A and B are stored.
  83.  
  84.      N       (input) INTEGER
  85.              The order of the matrices A and B.  N >= 0.
  86.  
  87.      A       (input/output) COMPLEX array, dimension (LDA, N)
  88.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading N-
  89.              by-N upper triangular part of A contains the upper triangular
  90.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  91.              triangular part of A contains the lower triangular part of the
  92.              matrix A.
  93.  
  94.              On exit, if JOBZ = 'V', then if INFO = 0, A contains the matrix Z
  95.              of eigenvectors.  The eigenvectors are normalized as follows:  if
  96.              ITYPE = 1 or 2, Z**H*B*Z = I; if ITYPE = 3, Z**H*inv(B)*Z = I.
  97.              If JOBZ = 'N', then on exit the upper triangle (if UPLO='U') or
  98.              the lower triangle (if UPLO='L') of A, including the diagonal, is
  99.              destroyed.
  100.  
  101.      LDA     (input) INTEGER
  102.              The leading dimension of the array A.  LDA >= max(1,N).
  103.  
  104.      B       (input/output) COMPLEX array, dimension (LDB, N)
  105.              On entry, the Hermitian matrix B.  If UPLO = 'U', the leading N-
  106.              by-N upper triangular part of B contains the upper triangular
  107.              part of the matrix B.  If UPLO = 'L', the leading N-by-N lower
  108.              triangular part of B contains the lower triangular part of the
  109.              matrix B.
  110.  
  111.              On exit, if INFO <= N, the part of B containing the matrix is
  112.              overwritten by the triangular factor U or L from the Cholesky
  113.              factorization B = U**H*U or B = L*L**H.
  114.  
  115.      LDB     (input) INTEGER
  116.              The leading dimension of the array B.  LDB >= max(1,N).
  117.  
  118.      W       (output) REAL array, dimension (N)
  119.              If INFO = 0, the eigenvalues in ascending order.
  120.  
  121.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  122.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LWORK   (input) INTEGER
  141.              The length of the array WORK.  If N <= 1,                LWORK >=
  142.              1.  If JOBZ  = 'N' and N > 1, LWORK >= N + 1.  If JOBZ  = 'V' and
  143.              N > 1, LWORK >= 2*N + N**2.
  144.  
  145.              If LWORK = -1, then a workspace query is assumed; the routine
  146.              only calculates the optimal size of the WORK array, returns this
  147.              value as the first entry of the WORK array, and no error message
  148.              related to LWORK is issued by XERBLA.
  149.  
  150.      RWORK   (workspace/output) REAL array, dimension (LRWORK)
  151.              On exit, if INFO = 0, RWORK(1) returns the optimal LRWORK.
  152.  
  153.      LRWORK  (input) INTEGER
  154.              The dimension of the array RWORK.  If N <= 1,
  155.              LRWORK >= 1.  If JOBZ  = 'N' and N > 1, LRWORK >= N.  If JOBZ  =
  156.              'V' and N > 1, LRWORK >= 1 + 5*N + 2*N**2.
  157.  
  158.              If LRWORK = -1, then a workspace query is assumed; the routine
  159.              only calculates the optimal size of the RWORK array, returns this
  160.              value as the first entry of the RWORK array, and no error message
  161.              related to LRWORK is issued by XERBLA.
  162.  
  163.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  164.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  165.  
  166.      LIWORK  (input) INTEGER
  167.              The dimension of the array IWORK.  If N <= 1,
  168.              LIWORK >= 1.  If JOBZ  = 'N' and N > 1, LIWORK >= 1.  If JOBZ  =
  169.              'V' and N > 1, LIWORK >= 3 + 5*N.
  170.  
  171.      INFO    (output) INTEGER
  172.              = 0:  successful exit
  173.              < 0:  if INFO = -i, the i-th argument had an illegal value
  174.              > 0:  CPOTRF or CHEEVD returned an error code:
  175.              <= N:  if INFO = i, CHEEVD failed to converge; i off-diagonal
  176.              elements of an intermediate tridiagonal form did not converge to
  177.              zero; > N:   if INFO = N + i, for 1 <= i <= N, then the leading
  178.              minor of order i of B is not positive definite.  The
  179.              factorization of B could not be completed and no eigenvalues or
  180.              eigenvectors were computed.
  181.  
  182. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  183.      Based on contributions by
  184.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  185.  
  186.  
  187. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  188.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))                                                          CCCCHHHHEEEEGGGGVVVVDDDD((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      This man page is available only online.
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.